Skip to main content

Configuring Kafka as a Broker Service in VIDIZMO

VIDIZMO offers multiple broker service options to manage real-time data feeds and enable smooth communication between microservices. Kafka is one of the broker services used in VIDIZMO. Apache Kafka, commonly known as a message broker service, is a distributed event streaming platform specially designed for handling real-time data feeds.

Prerequisites​

  1. Follow the official Apache Kafka documentation to complete the installation and setup of Kafka on the server where VIDIZMO is deployed.
  2. This is specific to on-premises VIDIZMO deployments and requires Administrator privileges (make sure you belongs to group in which configuration hub feature in enabled)

Configuring Kafka in VIDIZMO​

Launch Kafka using Docker​

To facilitate seamless management and version control of Apache Kafka, we recommend deploying Kafka using Docker. Utilizing Docker offers the advantage of effortlessly switching between Kafka versions by updating the underlying docker-compose file.

  1. Install Docker and ensure Docker Desktop is installed on your system by referring to the official Docker documentation.
  2. Download the Kafka Docker-Compose File by obtaining the Kafka docker-compose file from the official GitHub repository.
  3. Navigate to the downloaded folder where the docker-compose file is located.
  4. Execute the command `docker-compose -f zk-single-kafka-single.yml up -d` in the command prompt to initiate Kafka containers.

Configuration in VIDIZMO​

To configure the broker service in the VIDIZMO application, please follow the instructions below:

  1. Log in to the VIDIZMO application with Administrator privileges. Navigate to the Navigation Menu.
  2. Click on the Control Panel.

  1. Select the Application Configuration.
  2. Click on the VIDIZMO Runtime Configuration.

  1. Click 'Edit' to change/update the existing configuration.

  1. Under Event System, select Kafka from the drop-down menu.

  • BootStrap Servers: In the designated field, input the bootstrap server's information using the format localhost:KafkaPortNumber.
  • Specify the Zookeeper Port: Enter the port number, which can be obtained from Docker Desktop. Refer to the Zookeeper container in Docker Desktop, where the port number is listed in the port column. This ensures proper communication with the Zookeeper service. To get info about the requisite port for Kafka, refer to the prerequisites for the VIDIZMO Application.
  1. Click update to save configuration settings.